-
Notifications
You must be signed in to change notification settings - Fork 156
chore: Add llms.txt to documentation #3953
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From my side let's remove the Processes
section for now, since it's something I don't expect will help customers write better functions using Powertools.
After that I'm good to merge this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I dismissed by mistake, see previous comment.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding, I have confirmed that the files are generated correctly - still unclear whether they'll be useful, but that's another story.
Summary
Changes
Added missing requirements and run pip-compile.
This pull request introduces updates to documentation dependencies and configuration, primarily to integrate the
mkdocs-llmstxt
plugin and its associated resources.Dependency Updates:
mkdocs-llmstxt==0.2.0
todocs/requirements.in
anddocs/requirements.txt
for generating additional documentation outputs. [1] [2]docs/requirements.txt
to support Markdown and HTML processing:beautifulsoup4==4.13.4
(viamarkdownify
andmkdocs-llmstxt
).markdown-it-py==3.0.0
andmdurl==0.1.2
(viamdformat
). [1] [2]markdownify==1.1.0
(viamkdocs-llmstxt
).mdformat==0.7.22
(viamkdocs-llmstxt
).soupsieve==2.7
andtyping-extensions==4.13.2
(viabeautifulsoup4
).Configuration Changes:
mkdocs.yml
to add a new "Resources" section in the navigation, linking tollms.txt
and its full version.llmstxt
plugin inmkdocs.yml
with detailed settings, including descriptions, output paths, and categorized sections for documentation.Minor Adjustments:
docs/requirements.txt
to reflect Python 3.10 instead of 3.13.Issue number: #3952
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.